Skip to content

docs: document synchronous event listener behavior (#126)#135

Merged
coji merged 1 commit intomainfrom
docs/synchronous-event-listeners
Mar 16, 2026
Merged

docs: document synchronous event listener behavior (#126)#135
coji merged 1 commit intomainfrom
docs/synchronous-event-listeners

Conversation

@coji
Copy link
Owner

@coji coji commented Mar 16, 2026

Summary

  • Add "Synchronous Execution" section to Events API docs with warning, do/don't examples
  • Clarify error handling semantics (exceptions are caught but interrupt subsequent listeners)
  • Add sync execution note to llms.md Events section
  • Regenerate llms.txt

Closes #126

Follow-up

Codex review identified implementation issues that should be addressed separately:

  • withLogPersistence() uses an async event listener whose Promise is silently dropped
  • Async listeners' rejected Promises never reach onError
  • Consider runtime warning when a listener returns a thenable

These are tracked in new issues.

🤖 Generated with Claude Code

@coji @claude
docs: document synchronous event listener behavior (#126)
c108cd4 
Add warning about synchronous execution in worker hot path,
best practices for fast listeners, and clarify error handling semantics.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@vercel
Copy link

vercel bot commented Mar 16, 2026 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
durably-demo Ready Ready Preview Mar 16, 2026 1:32pm
durably-demo-vercel-turso Ready Ready Preview Mar 16, 2026 1:32pm

@coderabbitai
Copy link

coderabbitai bot commented Mar 16, 2026

Warning

Rate limit exceeded

@coji has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 6 minutes and 9 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: a90e5fb5-ed64-467b-a450-dcc996ed5e4a

📥 Commits

Reviewing files that changed from the base of the PR and between 91f950b and c108cd4.

📒 Files selected for processing (3)
  • packages/durably/docs/llms.md
  • website/api/events.md
  • website/public/llms.txt
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/synchronous-event-listeners
📝 Coding Plan
  • Generate coding plan for human review comments

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coji coji mentioned this pull request Mar 16, 2026
Closed
3 tasks
@coji coji merged commit 4940314 into main Mar 16, 2026
5 checks passed
@coji coji deleted the docs/synchronous-event-listeners branch March 16, 2026 13:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

docs: document synchronous event listener behavior

1 participant

@coji